vestige_api.json•163 kB
{
"openapi": "3.1.0",
"info": {
"title": "Vestige Labs API",
"description": "To be used with https://api.vestigelabs.org",
"version": "4.0.0"
},
"paths": {
"/networks": {
"get": {
"tags": [
"Networks"
],
"summary": "Get Networks",
"description": "Get all networks.",
"operationId": "get_networks_networks_get",
"responses": {
"200": {
"description": "Networks retrieved successfully",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/NetworkSerializer"
},
"type": "array",
"title": "Response Get Networks Networks Get"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/networks/{network_id}": {
"get": {
"tags": [
"Networks"
],
"summary": "Get Network By Id",
"description": "Get network by id.",
"operationId": "get_network_by_id_networks__network_id__get",
"parameters": [
{
"name": "network_id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
}
],
"responses": {
"200": {
"description": "Network retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetworkSerializer"
}
}
}
},
"404": {
"description": "Network not found"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/protocols": {
"get": {
"tags": [
"Protocols"
],
"summary": "Get Protocols",
"description": "Get all protocols.",
"operationId": "get_protocols_protocols_get",
"parameters": [
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
}
],
"responses": {
"200": {
"description": "Protocols retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProtocolSerializer"
},
"title": "Response Get Protocols Protocols Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/protocols/volume": {
"get": {
"tags": [
"Protocols"
],
"summary": "Get Protocol Volumes",
"description": "Get protocol volumes at specific day. Defaults to current day.",
"operationId": "get_protocol_volumes_protocols_volume_get",
"parameters": [
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
},
{
"name": "timestamp",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"title": "Timestamp"
}
},
{
"name": "denominating_asset_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"title": "Denominating Asset Id"
}
}
],
"responses": {
"200": {
"description": "Protocol volumes retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ProtocolVolumeSerializer"
},
"title": "Response Get Protocol Volumes Protocols Volume Get"
}
}
}
},
"404": {
"description": "Protocol not found"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/protocols/{protocol_id}": {
"get": {
"tags": [
"Protocols"
],
"summary": "Get Protocol By Id",
"description": "Get protocol by id.",
"operationId": "get_protocol_by_id_protocols__protocol_id__get",
"parameters": [
{
"name": "protocol_id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"title": "Protocol Id"
}
},
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
}
],
"responses": {
"200": {
"description": "Protocol retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProtocolSerializer"
}
}
}
},
"404": {
"description": "Protocol not found"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/assets": {
"get": {
"tags": [
"Assets"
],
"summary": "Get Assets",
"description": "Get data about assets",
"operationId": "get_assets_assets_get",
"parameters": [
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
},
{
"name": "asset_ids",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Asset Ids"
}
}
],
"responses": {
"200": {
"description": "Assets retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetSerializer"
},
"title": "Response Get Assets Assets Get"
}
}
}
},
"400": {
"description": "Invalid asset list"
},
"406": {
"description": "Too many assets"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/assets/search": {
"get": {
"tags": [
"Assets"
],
"summary": "Search Assets",
"description": "Search assets by query",
"operationId": "search_assets_assets_search_get",
"parameters": [
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
},
{
"name": "query",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Query"
}
},
{
"name": "protocol_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Protocol Id"
}
},
{
"name": "denominating_asset_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 0,
"title": "Denominating Asset Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0,
"title": "Offset"
}
},
{
"name": "order_by",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Order By"
}
},
{
"name": "order_dir",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^(asc|desc)$"
},
{
"type": "null"
}
],
"default": "desc",
"title": "Order Dir"
}
}
],
"responses": {
"200": {
"description": "Assets retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedResponse_AssetDetailSerializer_NoneType_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/assets/list": {
"get": {
"tags": [
"Assets"
],
"summary": "Get Asset List",
"operationId": "get_asset_list_assets_list_get",
"parameters": [
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
},
{
"name": "asset_ids",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Asset Ids"
}
},
{
"name": "denominating_asset_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 0,
"title": "Denominating Asset Id"
}
},
{
"name": "include_labels",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Include Labels"
}
},
{
"name": "exclude_labels",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Exclude Labels"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0,
"title": "Offset"
}
},
{
"name": "order_by",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Order By"
}
},
{
"name": "order_dir",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^(asc|desc)$"
},
{
"type": "null"
}
],
"default": "desc",
"title": "Order Dir"
}
},
{
"name": "tvl__lt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Tvl Lt"
}
},
{
"name": "tvl__gt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Tvl Gt"
}
},
{
"name": "market_cap__lt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Market Cap Lt"
}
},
{
"name": "market_cap__gt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Market Cap Gt"
}
},
{
"name": "fully_diluted_market_cap__lt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fully Diluted Market Cap Lt"
}
},
{
"name": "fully_diluted_market_cap__gt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fully Diluted Market Cap Gt"
}
},
{
"name": "volume1d__lt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Volume1D Lt"
}
},
{
"name": "volume1d__gt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Volume1D Gt"
}
},
{
"name": "created_at__lt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Created At Lt"
}
},
{
"name": "created_at__gt",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Created At Gt"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedResponse_AssetDetailSerializer_NoneType_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/assets/price": {
"get": {
"tags": [
"Assets"
],
"summary": "Get Asset Prices",
"description": "Get asset prices",
"operationId": "get_asset_prices_assets_price_get",
"parameters": [
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
},
{
"name": "asset_ids",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Asset Ids"
}
},
{
"name": "denominating_asset_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 0,
"title": "Denominating Asset Id"
}
}
],
"responses": {
"200": {
"description": "Asset prices retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetPriceSerializer"
},
"title": "Response Get Asset Prices Assets Price Get"
}
}
}
},
"400": {
"description": "Invalid asset list"
},
"406": {
"description": "Too many assets"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/assets/{asset_id}/candles": {
"get": {
"tags": [
"Assets"
],
"summary": "Get Asset Candles",
"description": "Get asset candles",
"operationId": "get_asset_candles_assets__asset_id__candles_get",
"parameters": [
{
"name": "asset_id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"title": "Asset Id"
}
},
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
},
{
"name": "interval",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Interval"
}
},
{
"name": "start",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Start"
}
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End"
}
},
{
"name": "denominating_asset_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 0,
"title": "Denominating Asset Id"
}
},
{
"name": "volume_in_denominating_asset",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Volume In Denominating Asset"
}
}
],
"responses": {
"200": {
"description": "Asset candles retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetCandleSerializer"
},
"title": "Response Get Asset Candles Assets Asset Id Candles Get"
}
}
}
},
"406": {
"description": "Too many candles"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/assets/{asset_id}/history": {
"get": {
"tags": [
"Assets"
],
"summary": "Get Asset History",
"description": "Get asset volume, swaps, total lockup, vwap and confidence history",
"operationId": "get_asset_history_assets__asset_id__history_get",
"parameters": [
{
"name": "asset_id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"title": "Asset Id"
}
},
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
},
{
"name": "interval",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Interval"
}
},
{
"name": "start",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Start"
}
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End"
}
},
{
"name": "denominating_asset_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 0,
"title": "Denominating Asset Id"
}
},
{
"name": "volume_in_denominating_asset",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Volume In Denominating Asset"
}
}
],
"responses": {
"200": {
"description": "Asset history retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetHistorySerializer"
},
"title": "Response Get Asset History Assets Asset Id History Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/assets/{asset_id}/composition": {
"get": {
"tags": [
"Assets"
],
"summary": "Get Asset Composition",
"description": "Get asset lockups based on protocol and pair, returns {protocol_id: {asset_id: lockup}}",
"operationId": "get_asset_composition_assets__asset_id__composition_get",
"parameters": [
{
"name": "asset_id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"title": "Asset Id"
}
},
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
}
],
"responses": {
"200": {
"description": "Asset composition retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"title": "Response Get Asset Composition Assets Asset Id Composition Get"
}
}
}
},
"404": {
"description": "Asset not found"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/pools": {
"get": {
"tags": [
"Pools"
],
"summary": "Get Pools",
"description": "Get pools.",
"operationId": "get_pools_pools_get",
"parameters": [
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
},
{
"name": "protocol_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Protocol Id"
}
},
{
"name": "other_protocol_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Other Protocol Id"
}
},
{
"name": "asset_1_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset 1 Id"
}
},
{
"name": "asset_2_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset 2 Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0,
"title": "Offset"
}
},
{
"name": "order_by",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Order By"
}
},
{
"name": "order_dir",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^(asc|desc)$"
},
{
"type": "null"
}
],
"default": "desc",
"title": "Order Dir"
}
}
],
"responses": {
"200": {
"description": "Pools retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedResponse_PoolSerializer_NoneType_"
}
}
}
},
"400": {
"description": "Invalid order by field"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/vaults": {
"get": {
"tags": [
"Vaults"
],
"summary": "Get Vaults",
"description": "Get all vaults.",
"operationId": "get_vaults_vaults_get",
"parameters": [
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
},
{
"name": "protocol_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Protocol Id"
}
},
{
"name": "asset_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset Id"
}
},
{
"name": "address",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Address"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0,
"title": "Offset"
}
},
{
"name": "order_by",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Order By"
}
},
{
"name": "order_dir",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^(asc|desc)$"
},
{
"type": "null"
}
],
"default": "desc",
"title": "Order Dir"
}
}
],
"responses": {
"200": {
"description": "Vaults retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedResponse_VaultSerializer_List_PoolSerializer__"
}
}
}
},
"400": {
"description": "Invalid order by field"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/balances": {
"get": {
"tags": [
"Balances"
],
"summary": "Get Balances",
"description": "Get balances by network id, protocol id and asset id.",
"operationId": "get_balances_balances_get",
"parameters": [
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
},
{
"name": "protocol_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Protocol Id"
}
},
{
"name": "address",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Address"
}
},
{
"name": "asset_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0,
"title": "Offset"
}
},
{
"name": "order_by",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Order By"
}
},
{
"name": "order_dir",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^(asc|desc)$"
},
{
"type": "null"
}
],
"default": "desc",
"title": "Order Dir"
}
}
],
"responses": {
"200": {
"description": "Balances retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedResponse_BalanceSerializer_NoneType_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/notes": {
"get": {
"tags": [
"Notes"
],
"summary": "Get Notes",
"description": "Get notes by network id and optionally asset id.",
"operationId": "get_notes_notes_get",
"parameters": [
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
},
{
"name": "asset_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0,
"title": "Offset"
}
},
{
"name": "order_by",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Order By"
}
},
{
"name": "order_dir",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^(asc|desc)$"
},
{
"type": "null"
}
],
"default": "desc",
"title": "Order Dir"
}
}
],
"responses": {
"200": {
"description": "Notes retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedResponse_NoteSerializer_NoneType_"
}
}
}
},
"400": {
"description": "Invalid order by field"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/notes/first": {
"get": {
"tags": [
"Notes"
],
"summary": "Get First Asset Notes",
"description": "Get first note for assets",
"operationId": "get_first_asset_notes_notes_first_get",
"parameters": [
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
},
{
"name": "asset_ids",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Asset Ids"
}
}
],
"responses": {
"200": {
"description": "First note for assets retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteSerializer"
},
"title": "Response Get First Asset Notes Notes First Get"
}
}
}
},
"400": {
"description": "Invalid asset list"
},
"406": {
"description": "Too many assets"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/notes/count": {
"get": {
"tags": [
"Notes"
],
"summary": "Get Asset Notes Count",
"description": "Get notes count for assets",
"operationId": "get_asset_notes_count_notes_count_get",
"parameters": [
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
},
{
"name": "asset_ids",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Asset Ids"
}
}
],
"responses": {
"200": {
"description": "Notes count retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotesCountSerializer"
},
"title": "Response Get Asset Notes Count Notes Count Get"
}
}
}
},
"400": {
"description": "Invalid asset list"
},
"406": {
"description": "Too many assets"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/swaps": {
"get": {
"tags": [
"Swaps"
],
"summary": "Get Swaps",
"description": "Get swaps.",
"operationId": "get_swaps_swaps_get",
"parameters": [
{
"name": "network_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Network Id"
}
},
{
"name": "start",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Start"
}
},
{
"name": "end",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "End"
}
},
{
"name": "protocol_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Protocol Id"
}
},
{
"name": "asset_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset Id"
}
},
{
"name": "address",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Address"
}
},
{
"name": "executor",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Executor"
}
},
{
"name": "next",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Next"
}
},
{
"name": "denominating_asset_id",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"title": "Denominating Asset Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 250,
"minimum": 1,
"default": 50,
"title": "Limit"
}
},
{
"name": "order_dir",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^(asc|desc)$"
},
{
"type": "null"
}
],
"default": "desc",
"title": "Order Dir"
}
}
],
"responses": {
"200": {
"description": "Swaps retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NextPaginatedResponse_SwapSerializer_NoneType_"
}
}
}
},
"400": {
"description": "Invalid order by field"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
},
"/swap/v4": {
"get": {
"tags": [
"Aggregator"
],
"summary": "Get Best V4 Swap Data",
"operationId": "get_best_v4_swap_data_swap_v4_get",
"parameters": [
{
"name": "from_asa",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "From Asa"
}
},
{
"name": "to_asa",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "To Asa"
}
},
{
"name": "amount",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Amount"
}
},
{
"name": "mode",
"in": "query",
"required": true,
"schema": {
"enum": [
"sef",
"sfe"
],
"type": "string",
"title": "Mode"
}
},
{
"name": "denominating_asset_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 0,
"title": "Denominating Asset Id"
}
},
{
"name": "enabled_providers",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Enabled Providers"
}
},
{
"name": "disabled_providers",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Disabled Providers"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateV4Serializer-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/swap/v4/fee": {
"get": {
"tags": [
"Aggregator"
],
"summary": "Get V4 Swap Discount",
"operationId": "get_v4_swap_discount_swap_v4_fee_get",
"parameters": [
{
"name": "address",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Address"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SwapFeeSerializer"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/swap/v4/transactions": {
"post": {
"tags": [
"Aggregator"
],
"summary": "Get V4 Swap Data Transactions",
"operationId": "get_v4_swap_data_transactions_swap_v4_transactions_post",
"parameters": [
{
"name": "sender",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Sender"
}
},
{
"name": "slippage",
"in": "query",
"required": true,
"schema": {
"type": "number",
"title": "Slippage"
}
},
{
"name": "random_signer",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Random Signer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateV4Serializer-Input"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UnsignedTransactionSerializer"
}
},
{
"type": "null"
}
],
"title": "Response Get V4 Swap Data Transactions Swap V4 Transactions Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/swap/v4/stats": {
"get": {
"tags": [
"Aggregator"
],
"summary": "Get Aggregator Stats",
"operationId": "get_aggregator_stats_swap_v4_stats_get",
"parameters": [
{
"name": "denominating_asset_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 0,
"title": "Denominating Asset Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregatorStatsSerializer"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/ping": {
"get": {
"tags": [
"Other"
],
"summary": "Echo",
"description": "Ping the server to check if it's alive.",
"operationId": "echo_ping_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/usage": {
"get": {
"tags": [
"Other"
],
"summary": "Get Api Usage",
"description": "Get usage statistics.",
"operationId": "get_api_usage_usage_get",
"parameters": [
{
"name": "hours",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 24,
"title": "Hours"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AggregateDataV4Serializer-Input": {
"properties": {
"asset_in": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset In"
},
"asset_out": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset Out"
},
"amount_in": {
"type": "integer",
"title": "Amount In"
},
"amount_out": {
"type": "integer",
"title": "Amount Out"
},
"network_fee": {
"type": "integer",
"title": "Network Fee"
},
"transactions": {
"items": {
"$ref": "#/components/schemas/AggregateV4TransactionSerializer"
},
"type": "array",
"title": "Transactions"
}
},
"type": "object",
"required": [
"asset_in",
"asset_out",
"amount_in",
"amount_out",
"network_fee",
"transactions"
],
"title": "AggregateDataV4Serializer"
},
"AggregateDataV4Serializer-Output": {
"properties": {
"asset_in": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset In"
},
"asset_out": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset Out"
},
"amount_in": {
"type": "integer",
"title": "Amount In"
},
"amount_out": {
"type": "integer",
"title": "Amount Out"
},
"network_fee": {
"type": "integer",
"title": "Network Fee"
},
"transactions": {
"items": {
"$ref": "#/components/schemas/AggregateV4TransactionSerializer"
},
"type": "array",
"title": "Transactions"
}
},
"type": "object",
"required": [
"asset_in",
"asset_out",
"amount_in",
"amount_out",
"network_fee",
"transactions"
],
"title": "AggregateDataV4Serializer"
},
"AggregateV4Serializer-Input": {
"properties": {
"mode": {
"type": "string",
"title": "Mode"
},
"amount": {
"type": "number",
"title": "Amount"
},
"asset_in": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset In"
},
"asset_in_price": {
"type": "number",
"title": "Asset In Price"
},
"asset_out": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset Out"
},
"asset_out_price": {
"type": "number",
"title": "Asset Out Price"
},
"asset_images": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Asset Images"
},
"combo": {
"anyOf": [
{
"$ref": "#/components/schemas/AggregateDataV4Serializer-Input"
},
{
"type": "null"
}
]
},
"single": {
"anyOf": [
{
"$ref": "#/components/schemas/AggregateDataV4Serializer-Input"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"mode",
"amount",
"asset_in",
"asset_in_price",
"asset_out",
"asset_out_price",
"asset_images",
"combo",
"single"
],
"title": "AggregateV4Serializer"
},
"AggregateV4Serializer-Output": {
"properties": {
"mode": {
"type": "string",
"title": "Mode"
},
"amount": {
"type": "number",
"title": "Amount"
},
"asset_in": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset In"
},
"asset_in_price": {
"type": "number",
"title": "Asset In Price"
},
"asset_out": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset Out"
},
"asset_out_price": {
"type": "number",
"title": "Asset Out Price"
},
"asset_images": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Asset Images"
},
"combo": {
"anyOf": [
{
"$ref": "#/components/schemas/AggregateDataV4Serializer-Output"
},
{
"type": "null"
}
]
},
"single": {
"anyOf": [
{
"$ref": "#/components/schemas/AggregateDataV4Serializer-Output"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"mode",
"amount",
"asset_in",
"asset_in_price",
"asset_out",
"asset_out_price",
"asset_images",
"combo",
"single"
],
"title": "AggregateV4Serializer"
},
"AggregateV4TransactionSerializer": {
"properties": {
"asset_in": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset In"
},
"asset_out": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Asset Out"
},
"amount_in": {
"type": "integer",
"title": "Amount In"
},
"amount_out": {
"type": "integer",
"title": "Amount Out"
},
"network_fee": {
"type": "integer",
"title": "Network Fee"
},
"swaps": {
"items": {
"$ref": "#/components/schemas/AggregateV4TransactionSwapSerializer"
},
"type": "array",
"title": "Swaps"
}
},
"type": "object",
"required": [
"asset_in",
"asset_out",
"amount_in",
"amount_out",
"network_fee",
"swaps"
],
"title": "AggregateV4TransactionSerializer"
},
"AggregateV4TransactionSwapSerializer": {
"properties": {
"provider": {
"type": "string",
"title": "Provider"
},
"bps": {
"type": "integer",
"title": "Bps"
},
"application_id": {
"type": "integer",
"title": "Application Id"
},
"amount_in": {
"type": "integer",
"title": "Amount In"
},
"amount_out": {
"type": "integer",
"title": "Amount Out"
},
"fee": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fee"
},
"network_fee": {
"type": "integer",
"title": "Network Fee"
}
},
"type": "object",
"required": [
"provider",
"bps",
"application_id",
"amount_in",
"amount_out",
"fee",
"network_fee"
],
"title": "AggregateV4TransactionSwapSerializer"
},
"AggregatorStatsSerializer": {
"properties": {
"addresses": {
"type": "integer",
"title": "Addresses"
},
"daily_swaps": {
"type": "integer",
"title": "Daily Swaps"
},
"weekly_swaps": {
"type": "integer",
"title": "Weekly Swaps"
},
"daily_volume": {
"type": "number",
"title": "Daily Volume"
},
"weekly_volume": {
"type": "number",
"title": "Weekly Volume"
},
"total_swaps": {
"type": "integer",
"title": "Total Swaps"
},
"total_volume": {
"type": "number",
"title": "Total Volume"
}
},
"type": "object",
"required": [
"addresses",
"daily_swaps",
"weekly_swaps",
"daily_volume",
"weekly_volume",
"total_swaps",
"total_volume"
],
"title": "AggregatorStatsSerializer"
},
"AssetCandleSerializer": {
"properties": {
"network_id": {
"type": "integer",
"title": "Network Id"
},
"asset_id": {
"type": "integer",
"title": "Asset Id"
},
"interval": {
"type": "integer",
"title": "Interval"
},
"denominating_asset_id": {
"type": "integer",
"title": "Denominating Asset Id"
},
"timestamp": {
"type": "integer",
"title": "Timestamp"
},
"open": {
"type": "number",
"title": "Open"
},
"high": {
"type": "number",
"title": "High"
},
"low": {
"type": "number",
"title": "Low"
},
"close": {
"type": "number",
"title": "Close"
},
"volume": {
"type": "number",
"title": "Volume"
},
"confidence": {
"type": "number",
"title": "Confidence"
}
},
"type": "object",
"required": [
"network_id",
"asset_id",
"interval",
"denominating_asset_id",
"timestamp",
"open",
"high",
"low",
"close",
"volume",
"confidence"
],
"title": "AssetCandleSerializer"
},
"AssetDetailSerializer": {
"properties": {
"rank": {
"type": "integer",
"title": "Rank"
},
"network_id": {
"type": "integer",
"title": "Network Id"
},
"id": {
"type": "integer",
"title": "Id"
},
"decimals": {
"type": "integer",
"title": "Decimals"
},
"created_at": {
"type": "integer",
"title": "Created At"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"ticker": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ticker"
},
"confidence": {
"type": "number",
"title": "Confidence"
},
"price": {
"type": "number",
"title": "Price"
},
"price1h": {
"type": "number",
"title": "Price1H"
},
"price1d": {
"type": "number",
"title": "Price1D"
},
"price7d": {
"type": "number",
"title": "Price7D"
},
"volume1h": {
"type": "number",
"title": "Volume1H"
},
"volume1d": {
"type": "number",
"title": "Volume1D"
},
"volume7d": {
"type": "number",
"title": "Volume7D"
},
"swaps1h": {
"type": "integer",
"title": "Swaps1H"
},
"swaps1d": {
"type": "integer",
"title": "Swaps1D"
},
"swaps7d": {
"type": "integer",
"title": "Swaps7D"
},
"views1h": {
"type": "integer",
"title": "Views1H"
},
"views1d": {
"type": "integer",
"title": "Views1D"
},
"total_lockup": {
"type": "number",
"title": "Total Lockup"
},
"vaulted_lockup": {
"type": "number",
"title": "Vaulted Lockup"
},
"total_supply": {
"type": "number",
"title": "Total Supply"
},
"circulating_supply": {
"type": "number",
"title": "Circulating Supply"
},
"burned_supply": {
"type": "number",
"title": "Burned Supply"
},
"vaulted_supply": {
"type": "number",
"title": "Vaulted Supply"
},
"market_cap": {
"type": "number",
"title": "Market Cap"
},
"fully_diluted_market_cap": {
"type": "number",
"title": "Fully Diluted Market Cap"
},
"tvl": {
"type": "number",
"title": "Tvl"
},
"labels": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Labels"
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
}
},
"type": "object",
"required": [
"rank",
"network_id",
"id",
"decimals",
"created_at",
"name",
"ticker",
"confidence",
"price",
"price1h",
"price1d",
"price7d",
"volume1h",
"volume1d",
"volume7d",
"swaps1h",
"swaps1d",
"swaps7d",
"views1h",
"views1d",
"total_lockup",
"vaulted_lockup",
"total_supply",
"circulating_supply",
"burned_supply",
"vaulted_supply",
"market_cap",
"fully_diluted_market_cap",
"tvl",
"labels",
"image"
],
"title": "AssetDetailSerializer"
},
"AssetHistorySerializer": {
"properties": {
"network_id": {
"type": "integer",
"title": "Network Id"
},
"asset_id": {
"type": "integer",
"title": "Asset Id"
},
"interval": {
"type": "integer",
"title": "Interval"
},
"denominating_asset_id": {
"type": "integer",
"title": "Denominating Asset Id"
},
"timestamp": {
"type": "integer",
"title": "Timestamp"
},
"volume": {
"type": "number",
"title": "Volume"
},
"tvl": {
"type": "number",
"title": "Tvl"
},
"swaps": {
"type": "integer",
"title": "Swaps"
},
"vwap": {
"type": "number",
"title": "Vwap"
},
"confidence": {
"type": "number",
"title": "Confidence"
}
},
"type": "object",
"required": [
"network_id",
"asset_id",
"interval",
"denominating_asset_id",
"timestamp",
"volume",
"tvl",
"swaps",
"vwap",
"confidence"
],
"title": "AssetHistorySerializer"
},
"AssetPriceSerializer": {
"properties": {
"network_id": {
"type": "integer",
"title": "Network Id"
},
"asset_id": {
"type": "integer",
"title": "Asset Id"
},
"denominating_asset_id": {
"type": "integer",
"title": "Denominating Asset Id"
},
"price": {
"type": "number",
"title": "Price"
},
"confidence": {
"type": "number",
"title": "Confidence"
},
"total_lockup": {
"type": "number",
"title": "Total Lockup"
}
},
"type": "object",
"required": [
"network_id",
"asset_id",
"denominating_asset_id",
"price",
"confidence",
"total_lockup"
],
"title": "AssetPriceSerializer"
},
"AssetSerializer": {
"properties": {
"network_id": {
"type": "integer",
"title": "Network Id"
},
"id": {
"type": "integer",
"title": "Id"
},
"created_at": {
"type": "integer",
"title": "Created At"
},
"updated_at": {
"type": "integer",
"title": "Updated At"
},
"hidden": {
"type": "boolean",
"title": "Hidden"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"ticker": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ticker"
},
"decimals": {
"type": "integer",
"title": "Decimals"
},
"creator": {
"type": "string",
"title": "Creator"
},
"manager": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Manager"
},
"reserve": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reserve"
},
"clawback": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Clawback"
},
"freeze": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Freeze"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"total_supply": {
"type": "integer",
"title": "Total Supply"
},
"circulating_supply": {
"type": "integer",
"title": "Circulating Supply"
},
"burned_supply": {
"type": "integer",
"title": "Burned Supply"
},
"f_type": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "F Type"
},
"f_asset_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "F Asset Id"
},
"f_application_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "F Application Id"
},
"f_extra": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "F Extra"
}
},
"type": "object",
"required": [
"network_id",
"id",
"created_at",
"updated_at",
"hidden",
"name",
"ticker",
"decimals",
"creator",
"manager",
"reserve",
"clawback",
"freeze",
"url",
"total_supply",
"circulating_supply",
"burned_supply",
"f_type",
"f_asset_id",
"f_application_id",
"f_extra"
],
"title": "AssetSerializer"
},
"BalanceSerializer": {
"properties": {
"network_id": {
"type": "integer",
"title": "Network Id"
},
"protocol_id": {
"type": "integer",
"title": "Protocol Id"
},
"address": {
"type": "string",
"title": "Address"
},
"created_at": {
"type": "integer",
"title": "Created At"
},
"updated_at": {
"type": "integer",
"title": "Updated At"
},
"claimed_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Claimed At"
},
"asset_id": {
"type": "integer",
"title": "Asset Id"
},
"amount": {
"type": "integer",
"title": "Amount"
}
},
"type": "object",
"required": [
"network_id",
"protocol_id",
"address",
"created_at",
"updated_at",
"claimed_at",
"asset_id",
"amount"
],
"title": "BalanceSerializer"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"NetworkSerializer": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"stage": {
"type": "string",
"title": "Stage"
},
"block": {
"type": "integer",
"title": "Block"
},
"network_block": {
"type": "integer",
"title": "Network Block"
},
"blocks_behind": {
"type": "integer",
"title": "Blocks Behind"
},
"cache_updated_at": {
"type": "integer",
"title": "Cache Updated At"
},
"cache_seconds": {
"type": "integer",
"title": "Cache Seconds"
}
},
"type": "object",
"required": [
"id",
"name",
"stage",
"block",
"network_block",
"blocks_behind",
"cache_updated_at",
"cache_seconds"
],
"title": "NetworkSerializer"
},
"NextPaginatedResponse_SwapSerializer_NoneType_": {
"properties": {
"results": {
"items": {
"$ref": "#/components/schemas/SwapSerializer"
},
"type": "array",
"title": "Results"
},
"extra": {
"type": "null",
"title": "Extra"
},
"limit": {
"type": "integer",
"title": "Limit"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"order_dir": {
"type": "string",
"title": "Order Dir"
}
},
"type": "object",
"required": [
"results",
"extra",
"limit",
"next",
"order_dir"
],
"title": "NextPaginatedResponse[SwapSerializer, NoneType]"
},
"NoteSerializer": {
"properties": {
"network_id": {
"type": "integer",
"title": "Network Id"
},
"offset": {
"type": "integer",
"title": "Offset"
},
"timestamp": {
"type": "integer",
"title": "Timestamp"
},
"address": {
"type": "string",
"title": "Address"
},
"asset_id": {
"type": "integer",
"title": "Asset Id"
},
"tip": {
"type": "integer",
"title": "Tip"
},
"content": {
"type": "string",
"title": "Content"
}
},
"type": "object",
"required": [
"network_id",
"offset",
"timestamp",
"address",
"asset_id",
"tip",
"content"
],
"title": "NoteSerializer"
},
"NotesCountSerializer": {
"properties": {
"network_id": {
"type": "integer",
"title": "Network Id"
},
"asset_id": {
"type": "integer",
"title": "Asset Id"
},
"notes": {
"type": "integer",
"title": "Notes"
},
"min_timestamp": {
"type": "integer",
"title": "Min Timestamp"
},
"max_timestamp": {
"type": "integer",
"title": "Max Timestamp"
}
},
"type": "object",
"required": [
"network_id",
"asset_id",
"notes",
"min_timestamp",
"max_timestamp"
],
"title": "NotesCountSerializer"
},
"PaginatedResponse_AssetDetailSerializer_NoneType_": {
"properties": {
"count": {
"type": "integer",
"title": "Count"
},
"results": {
"items": {
"$ref": "#/components/schemas/AssetDetailSerializer"
},
"type": "array",
"title": "Results"
},
"extra": {
"type": "null",
"title": "Extra"
},
"limit": {
"type": "integer",
"title": "Limit"
},
"offset": {
"type": "integer",
"title": "Offset"
},
"order_by": {
"type": "string",
"title": "Order By"
},
"order_dir": {
"type": "string",
"title": "Order Dir"
}
},
"type": "object",
"required": [
"count",
"results",
"extra",
"limit",
"offset",
"order_by",
"order_dir"
],
"title": "PaginatedResponse[AssetDetailSerializer, NoneType]"
},
"PaginatedResponse_BalanceSerializer_NoneType_": {
"properties": {
"count": {
"type": "integer",
"title": "Count"
},
"results": {
"items": {
"$ref": "#/components/schemas/BalanceSerializer"
},
"type": "array",
"title": "Results"
},
"extra": {
"type": "null",
"title": "Extra"
},
"limit": {
"type": "integer",
"title": "Limit"
},
"offset": {
"type": "integer",
"title": "Offset"
},
"order_by": {
"type": "string",
"title": "Order By"
},
"order_dir": {
"type": "string",
"title": "Order Dir"
}
},
"type": "object",
"required": [
"count",
"results",
"extra",
"limit",
"offset",
"order_by",
"order_dir"
],
"title": "PaginatedResponse[BalanceSerializer, NoneType]"
},
"PaginatedResponse_NoteSerializer_NoneType_": {
"properties": {
"count": {
"type": "integer",
"title": "Count"
},
"results": {
"items": {
"$ref": "#/components/schemas/NoteSerializer"
},
"type": "array",
"title": "Results"
},
"extra": {
"type": "null",
"title": "Extra"
},
"limit": {
"type": "integer",
"title": "Limit"
},
"offset": {
"type": "integer",
"title": "Offset"
},
"order_by": {
"type": "string",
"title": "Order By"
},
"order_dir": {
"type": "string",
"title": "Order Dir"
}
},
"type": "object",
"required": [
"count",
"results",
"extra",
"limit",
"offset",
"order_by",
"order_dir"
],
"title": "PaginatedResponse[NoteSerializer, NoneType]"
},
"PaginatedResponse_PoolSerializer_NoneType_": {
"properties": {
"count": {
"type": "integer",
"title": "Count"
},
"results": {
"items": {
"$ref": "#/components/schemas/PoolSerializer"
},
"type": "array",
"title": "Results"
},
"extra": {
"type": "null",
"title": "Extra"
},
"limit": {
"type": "integer",
"title": "Limit"
},
"offset": {
"type": "integer",
"title": "Offset"
},
"order_by": {
"type": "string",
"title": "Order By"
},
"order_dir": {
"type": "string",
"title": "Order Dir"
}
},
"type": "object",
"required": [
"count",
"results",
"extra",
"limit",
"offset",
"order_by",
"order_dir"
],
"title": "PaginatedResponse[PoolSerializer, NoneType]"
},
"PaginatedResponse_VaultSerializer_List_PoolSerializer__": {
"properties": {
"count": {
"type": "integer",
"title": "Count"
},
"results": {
"items": {
"$ref": "#/components/schemas/VaultSerializer"
},
"type": "array",
"title": "Results"
},
"extra": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/PoolSerializer"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Extra"
},
"limit": {
"type": "integer",
"title": "Limit"
},
"offset": {
"type": "integer",
"title": "Offset"
},
"order_by": {
"type": "string",
"title": "Order By"
},
"order_dir": {
"type": "string",
"title": "Order Dir"
}
},
"type": "object",
"required": [
"count",
"results",
"extra",
"limit",
"offset",
"order_by",
"order_dir"
],
"title": "PaginatedResponse[VaultSerializer, List[PoolSerializer]]"
},
"PoolSerializer": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"network_id": {
"type": "integer",
"title": "Network Id"
},
"protocol_id": {
"type": "integer",
"title": "Protocol Id"
},
"created_at": {
"type": "integer",
"title": "Created At"
},
"updated_at": {
"type": "integer",
"title": "Updated At"
},
"address": {
"type": "string",
"title": "Address"
},
"application_id": {
"type": "integer",
"title": "Application Id"
},
"fee": {
"type": "integer",
"title": "Fee"
},
"token_id": {
"type": "integer",
"title": "Token Id"
},
"token_supply": {
"type": "integer",
"title": "Token Supply"
},
"asset_1_id": {
"type": "integer",
"title": "Asset 1 Id"
},
"asset_1_supply": {
"type": "integer",
"title": "Asset 1 Supply"
},
"asset_2_id": {
"type": "integer",
"title": "Asset 2 Id"
},
"asset_2_supply": {
"type": "integer",
"title": "Asset 2 Supply"
}
},
"type": "object",
"required": [
"id",
"network_id",
"protocol_id",
"created_at",
"updated_at",
"address",
"application_id",
"fee",
"token_id",
"token_supply",
"asset_1_id",
"asset_1_supply",
"asset_2_id",
"asset_2_supply"
],
"title": "PoolSerializer"
},
"ProtocolSerializer": {
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"active": {
"type": "boolean",
"title": "Active"
},
"name": {
"type": "string",
"title": "Name"
},
"version": {
"type": "string",
"title": "Version"
},
"url": {
"type": "string",
"title": "Url"
},
"tvl": {
"type": "number",
"title": "Tvl"
}
},
"type": "object",
"required": [
"id",
"active",
"name",
"version",
"url",
"tvl"
],
"title": "ProtocolSerializer"
},
"ProtocolVolumeAssetSerializer": {
"properties": {
"swaps": {
"type": "integer",
"title": "Swaps"
},
"amount": {
"type": "number",
"title": "Amount"
},
"volume": {
"type": "number",
"title": "Volume"
},
"vwap": {
"type": "number",
"title": "Vwap"
},
"confidence": {
"type": "number",
"title": "Confidence"
}
},
"type": "object",
"required": [
"swaps",
"amount",
"volume",
"vwap",
"confidence"
],
"title": "ProtocolVolumeAssetSerializer"
},
"ProtocolVolumeSerializer": {
"properties": {
"denominating_asset_id": {
"type": "integer",
"title": "Denominating Asset Id"
},
"total_swaps": {
"type": "integer",
"title": "Total Swaps"
},
"total_volume": {
"type": "number",
"title": "Total Volume"
},
"assets": {
"additionalProperties": {
"$ref": "#/components/schemas/ProtocolVolumeAssetSerializer"
},
"type": "object",
"title": "Assets"
}
},
"type": "object",
"required": [
"denominating_asset_id",
"total_swaps",
"total_volume",
"assets"
],
"title": "ProtocolVolumeSerializer"
},
"SwapFeeSerializer": {
"properties": {
"token_amount": {
"type": "integer",
"title": "Token Amount"
},
"token_liquidity_amount": {
"type": "integer",
"title": "Token Liquidity Amount"
},
"bps_fee": {
"type": "integer",
"title": "Bps Fee"
}
},
"type": "object",
"required": [
"token_amount",
"token_liquidity_amount",
"bps_fee"
],
"title": "SwapFeeSerializer"
},
"SwapSerializer": {
"properties": {
"type": {
"type": "integer",
"title": "Type"
},
"network_id": {
"type": "integer",
"title": "Network Id"
},
"protocol_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Protocol Id"
},
"asset_1_id": {
"type": "integer",
"title": "Asset 1 Id"
},
"asset_2_id": {
"type": "integer",
"title": "Asset 2 Id"
},
"offset": {
"type": "integer",
"title": "Offset"
},
"block": {
"type": "integer",
"title": "Block"
},
"timestamp": {
"type": "integer",
"title": "Timestamp",
"description": "Unix timestamp of the swap"
},
"group": {
"type": "string",
"title": "Group"
},
"address": {
"type": "string",
"title": "Address"
},
"executor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Executor"
},
"asset_1_delta": {
"type": "number",
"title": "Asset 1 Delta",
"description": "Delta of asset 1 according to executor or pool"
},
"asset_2_delta": {
"type": "number",
"title": "Asset 2 Delta",
"description": "Delta of asset 2 according to executor or pool"
},
"asset_1_delta_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Asset 1 Delta Value",
"description": "Value of asset 1 delta in network units or specified asset"
},
"asset_2_delta_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Asset 2 Delta Value",
"description": "Value of asset 2 delta in network units or specified asset"
},
"token_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Token Id"
},
"token_delta": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Token Delta"
},
"token_supply": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Token Supply"
}
},
"type": "object",
"required": [
"type",
"network_id",
"asset_1_id",
"asset_2_id",
"offset",
"block",
"timestamp",
"group",
"address",
"asset_1_delta",
"asset_2_delta",
"asset_1_delta_value",
"asset_2_delta_value"
],
"title": "SwapSerializer"
},
"UnsignedTransactionSerializer": {
"properties": {
"txn": {
"type": "string",
"title": "Txn"
},
"signers": {
"items": {
"type": "string"
},
"type": "array",
"title": "Signers"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message"
}
},
"type": "object",
"required": [
"txn",
"signers",
"message"
],
"title": "UnsignedTransactionSerializer"
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"VaultSerializer": {
"properties": {
"network_id": {
"type": "integer",
"title": "Network Id"
},
"protocol_id": {
"type": "integer",
"title": "Protocol Id"
},
"id": {
"type": "integer",
"title": "Id"
},
"created_at": {
"type": "integer",
"title": "Created At"
},
"updated_at": {
"type": "integer",
"title": "Updated At"
},
"type": {
"type": "integer",
"title": "Type"
},
"deployer": {
"type": "string",
"title": "Deployer"
},
"claimer": {
"type": "string",
"title": "Claimer"
},
"asset_id": {
"type": "integer",
"title": "Asset Id"
},
"steps": {
"type": "integer",
"title": "Steps"
},
"amount_per_step": {
"type": "integer",
"title": "Amount Per Step"
},
"time_per_step": {
"type": "integer",
"title": "Time Per Step"
},
"is_done": {
"type": "boolean",
"title": "Is Done"
},
"initial_amount": {
"type": "integer",
"title": "Initial Amount"
},
"given_amount": {
"type": "integer",
"title": "Given Amount"
},
"prev_release": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Prev Release"
},
"next_release": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Next Release"
},
"extra": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Extra"
}
},
"type": "object",
"required": [
"network_id",
"protocol_id",
"id",
"created_at",
"updated_at",
"type",
"deployer",
"claimer",
"asset_id",
"steps",
"amount_per_step",
"time_per_step",
"is_done",
"initial_amount",
"given_amount",
"prev_release",
"next_release",
"extra"
],
"title": "VaultSerializer"
}
}
}
}